core/androidx.core.app/[main]NotificationCompat/BigPictureStyle

BigPictureStyle

open class BigPictureStyle : NotificationCompat.Style(source)

Helper class for generating large-format notifications that include a large image attachment. If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:

Notification notification = new NotificationCompat.Builder(mContext)
    .setContentTitle("New photo from " + sender.toString())
    .setContentText(subject)
    .setSmallIcon(R.drawable.new_post)
    .setLargeIcon(aBitmap)
    .setStyle(new Notification.BigPictureStyle()
        .bigPicture(aBigBitmap))
    .build();

See also

Constructors

BigPictureStyle

constructor()

constructor(@Nullable builder: NotificationCompat.Builder)

Functions

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun apply(builder: NotificationBuilderWithBuilderAccessor)

open fun bigLargeIcon(@Nullable b: Bitmap): NotificationCompat.BigPictureStyle

@RequiresApi(value = 23)

open fun bigLargeIcon(@Nullable i: Icon): NotificationCompat.BigPictureStyle

Override the large icon when the big notification is shown.

open fun bigPicture(@Nullable b: Bitmap): NotificationCompat.BigPictureStyle

Provide the bitmap to be used as the payload for the BigPicture notification.

@RequiresApi(value = 31)

open fun bigPicture(@Nullable i: Icon): NotificationCompat.BigPictureStyle

Provide an icon to be used as the payload for the BigPicture notification.

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getPictureIcon(@Nullable extras: Bundle): IconCompat

setBigContentTitle

open fun setBigContentTitle(@Nullable title: CharSequence): NotificationCompat.BigPictureStyle

Overrides ContentTitle in the big form of the template.

setContentDescription

@RequiresApi(value = 31)

open fun setContentDescription(@Nullable contentDescription: CharSequence): NotificationCompat.BigPictureStyle

Set the content description of the big picture.

open fun setSummaryText(@Nullable cs: CharSequence): NotificationCompat.BigPictureStyle

Set the first line of text after the detail section in the big form of the template.

showBigPictureWhenCollapsed

@RequiresApi(value = 31)

open fun showBigPictureWhenCollapsed(show: Boolean): NotificationCompat.BigPictureStyle

When set, the big picture of this style will be promoted and shown in place of the large icon in the collapsed state of this notification.